PACKAGE

lib.ft4.core.assets

FT4 Library / FT4 Library

Types

asset

An asset represents anything that is fungible. It can be more than money,

asset_filter

Filter used for the query getassetsfiltered to fetch assets based on selected criteria

balance

Represents an account's holdings of a certain asset.

balance_filter

Filter used for the query getbalancesfiltered to fetch balances based on selected criteria

crosschain_transfer_history_entry

Represents the cross-chain movement of an asset on the origin or target chain.

crosschain_transfer_history_entry_filter

Filter used for the query getcrosschaintransferhistoryentriesfiltered to fetch balances entries on selected criteria

filter

Filter used in queries, which allows to fetch only one direction of transfer

transfer_detail

Details about a transfer. It contains a limited set of information that can be used to

transfer_history_entry

Represents the movement of an asset in or out of an account.

transfer_history_entry_filter

Filter used for the query gettransferhistoryentriesfiltered to fetch entries based on selected criteria

transfer_type

The type of a transfer, used for filtering in queries

Functions

Asset

Returns the asset with the specified id as an entity.

after_burn

Extendable function that allows the developer to add more functionality to the

after_mint

Extendable function that allows the developer to add more functionality to the

after_transfer

Extendable function that allows the developer to add more functionality to the

before_burn

Extendable function that allows the developer to add more functionality to the

before_mint

Extendable function that allows the developer to add more functionality to the

before_transfer

Extendable function that allows the developer to add more functionality to the

create_on_internal_transfer

Extendable function that defines how to create an account when an on-chain transfer to a

deduct_balance

Removes a certain amount of money from an account. It does NOT update total supply,

extract_data_from_transfer_history_entry

Maps an entry's info into a readable format for the frontend

extract_data_from_transfer_history_list

Takes a list of transfer history entries and builds a page that can be returned

extract_details_from_account_creation_transfer

Analogous to extractdetailsfromtransferhistoryentry, but extracts data from the

extract_details_from_crosschain_transfer_history_entry

Maps a crosschaintransferhistoryentry to a transferdetail object.

extract_details_from_transfer_history_entry

Maps a transferhistoryentry to a transferdetail object.

extract_operation_name

Extracts the name of the operation that caused the transfer to happen.

format_amount_with_decimals

Creates a readable string representing the amount of tokens, given the raw

get_all_assets

Retrieves all registered assets, paginated.

get_asset_balance

Returns how much of an asset the account holds.

get_asset_balances

Retrieves all asset balances for a certain account.

get_asset_details_for_crosschain_registration

Outputs the details of an asset in a format that is used by other chains to register

get_assets_by_type

Retrieves all assets of a specified type, paginated.

get_assets_filtered

Retrieves all assets based on the selected filter of assetfilter, paginated

get_balances_filtered

Retrieves all balances based on the selected filter of balancefilter, paginated

get_crosschain_transfer_history_entries_filtered

Retrieves all crosschain transfer history entries based on the provided filtering, paginated

get_paginated_asset_balances

Retrieves all the balances of a certain account, paginated.

get_paginated_assets_by_name

Retrieves all assets with the given name, paginated.

get_paginated_assets_by_symbol

Retrieves all assets with the given symbol, paginated.

get_paginated_transfers

Fetches all transfers, allowing filtering in multiple ways. Paginated.

get_transfer_details

Returns a transferdetail object for each transferentry that was registered during

get_transfer_details_by_asset

Same as gettransferdetails, but restricts the results to transfer entries related

get_transfer_history_entries_filtered

Fetches all transfer history entries allowing filtering in multiple ways, paginated.

increase_balance

Adds a certain amount of money to an account. It does NOT update total supply, extra

is_create_on_internal_transfer_enabled

Extendable function that defines whether on-chain transfers towards an account that doesn't

map_asset

Maps an asset's info into a readable format for the frontend.

map_balance

Maps an balance info into a readable format for the frontend.

parse_icon_url

Tests whether an asset icon URL is invalid. It will not try to resolve the URL, but it will

recall_on_internal_transfer

Extendable function that defines how to recall a transfer that was erroneously made

require_zero_exclusive_asset_amount_limits

Ensures that an asset amount is in the interval (0; 2^256) (exclusive)

validate_asset_decimals

Ensures that decimals are in the interval 0; 78 (inclusive)

validate_asset_id

Ensures that the ID has exactly 32 bytes

validate_asset_name

Ensures that the text input is at most 1024 characters long.

validate_asset_symbol

Ensures that the text input is at most 1024 characters long.

validate_asset_type

Ensures that the text input is not empty and at most 1024 characters long.

validate_asset_uniqueness_resolver

Ensures that the asset uniqueness resolver is at most 1024 bytes long.

Properties

ASSET_TYPE_FT4

The type of fungible assets. By default, assets created with this library will have

max_asset_amount

The maximum value that should ever be represented when talking about assets.